home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / CD-ROM Tools / CompactPlayer / CompactPlayer.doc < prev    next >
Text File  |  1996-09-26  |  10KB  |  229 lines
  1.     NAME
  2.  
  3.         CompactPlayer
  4.  
  5.     DESCRIPTION
  6.  
  7.         CompactPlayer is a CD Audio player for SCSI CD-ROMs, similar to MCDP,
  8.         YACDP, CDPD, or CDP.
  9.  
  10.         CompactPlayer uses the ClassAct GUI toolkit and is compatible with
  11.         MCDP's CD index files. In fact, MCDP had a heavy influence on
  12.         CompactPlayer, in particular the SCSI routines.
  13.  
  14.     COPYRIGHT AND DISCLAIMER
  15.  
  16.         CompactPlayer is Copyright © 1995 Osma Ahvenlampi
  17.         ClassAct is Copyright © 1995 Phantom Development
  18.  
  19.         COMPACTPLAYER IS PROVIDED "AS IS". BY USING COMPACTPLAYER, YOU ACCEPT
  20.         THE RESPONSIBILITY FOR ANY DAMAGE OR LOSS THAT MAY OCCUR DURING OR
  21.         BECAUSE OF ITS USE, DIRECTLY OR INDIRECTLY. THE FITNESS OF
  22.         COMPACTPLAYER FOR ANY USE OR PURPOSE IS NOT GUARANTEED. THE AUTHOR IS
  23.         NOT, AND CAN NOT BE HELD LIABLE FOR ANYTHING.
  24.  
  25.         CompactPlayer is GIFTWARE. If you like CompactPlayer, please send a
  26.         small gift (a chocolate bar, your own program, $5, or even just a
  27.         postcard) to me. My address is in the end of this document. By doing
  28.         this you encourage further development of quality Amiga programs.
  29.  
  30.     COMPATIBILITY
  31.  
  32.         CompactPlayer has been developed and tested on an Amiga 3000 and
  33.         Toshiba XM3601B, using AmigaOS 3.1. The SCSI chip used was the
  34.         -4PROTO model. Compatibility with other CD-ROM devices is unknown.
  35.  
  36.         Due to notorious incompatibility between various so-called "standard"
  37.         SCSI-2 devices, especially CD-ROMs, it is very likely that this
  38.         program will have problems with some installations. It may even lock
  39.         up the whole SCSI bus, forcing you to reboot. You have been warned.
  40.         However, I hope this works for you, because it IS a rather neat
  41.         little program ;)
  42.  
  43.     USAGE
  44.  
  45.         CompactPlayer understands the following tooltypes or command line
  46.         arguments:
  47.  
  48.         DEVICE      The SCSI device driver to use. Default: scsi.device
  49.         UNIT        The SCSI ID of the CD-ROM. Default: 6
  50.         PUBSCREEN   The screen to open the interface on.
  51.         INDEXPATH   The directory where the CD descriptor files reside.
  52.         XPOS,YPOS   The initial coordinates of the interface.
  53.         TINYFONT    The small proportional font used.
  54.         PANELFONT   The nonproportional font used for the status panel.
  55.  
  56.         Other than that, insert a CD, press the "play" button. ;)
  57.  
  58.         The status panel gadget displays the following information:
  59.  
  60.         First line: ("xx xx:xx xx:xx xx:xx xx:xx")
  61.         - The number of tracks on the CD, or the current track when playing.
  62.         - Current playing of this track.
  63.         - Remaining time on this track.
  64.         - Current playing time from the beginning of the CD.
  65.         - Total lenght of the CD.
  66.  
  67.         Second line: The artist name of the CD.
  68.  
  69.         Third line: The CD title or the name of the current track.
  70.  
  71.         Fourth line: a graph displaying the relative lenghts of the tracks
  72.         on the CD, with a plotted line above it displaying the parts that
  73.         have been played.
  74.  
  75.         In the lower right corner is a small icon displaying the current
  76.         status of the player. Possible icons are "play", "stop", "paused",
  77.         empty, and a question mark signifying that CompactPlayer thinks the
  78.         CD tray is ejected. See the note below about the latter.
  79.  
  80.         Below the status panel is a simple row of normal tape deck controls.
  81.         The "rewind" and "fast forward" buttons have two modes. When not
  82.         playing, they will select the track where playing should begin, when
  83.         playing they function as seek buttons, seeking on the CD at 10 times
  84.         normal speed.
  85.  
  86.         On the right is a listview of the CD tracks. Selecting a title will
  87.         make CompactPlayer seek to that track and start playing.
  88.  
  89.         Above the listview are buttons for bringing up the title and program
  90.         editor windows. Unfortunately the program editor is as of now still
  91.         unimplemented, but the title editor exists.
  92.  
  93.         In the title editor you will see two string gadgets for the artist
  94.         and CD names, and below them a listview of the tracks on the CD and a
  95.         string gadget for editing the track titles. Select a track and type
  96.         in the name. After filling all the information about the CD, press
  97.         the Save Titles button to save the titles in a file in the directory
  98.         set with the INDEXPATH tooltype. CompactPlayer will now recognise the
  99.         CD when inserted and display the names of the tracks instead of just
  100.         numbers.
  101.         
  102.         In the menus is available a third window for selecting the device
  103.         used by CompactPlayer to access the CD-ROM. In this window, choose
  104.         the SCSI device to which the CD-ROM is connected, wait a while for
  105.         CompactPlayer to scan the SCSI bus, and then choose the CD-ROM from
  106.         the device list on the right. After this, click on "Use this".
  107.  
  108.         CompactPlayer is also keyboard controllable. The keys are:
  109.  
  110.         Space        -- Play/Pause, load tray if ejected.
  111.         Enter        -- Stop/Eject
  112.         T            -- Open title editor
  113.         Cursor Up    -- Select previous track
  114.         Cursor Down  -- Select next track
  115.         Cursor Left  -- Seek backwards
  116.         Cursor Right -- Seek forwards
  117.  
  118.         CompactPlayer interface can be zoomed to only the panel gadget, or
  119.         iconified completely using the title bar gadgets.
  120.  
  121.     AREXX PORT
  122.  
  123.         CompactPlayer also has an ARexx interface. The commands understood
  124.         are:
  125.  
  126.         PLAY TRACK/N    Play (selected track)
  127.         STOP            Stop playing
  128.         PAUSE           Pause playing
  129.         RESUME          Resume playing after a pause
  130.         EJECT           Eject tray
  131.         LOAD            Load tray
  132.         QUIT            Exit CompactPlayer
  133.         ACTIVATE        Uniconify CompactPlayer, bring it to front.
  134.         DEACTIVATE      Iconify CompactPlayer.
  135.  
  136.     NOTE ABOUT CD TRAY EJECTION
  137.  
  138.         CompactPlayer supports retracting the CD tray when it has been
  139.         ejected. However, to my best knowledge it is not possible to query
  140.         a CD-ROM drive whether the tray is out or not via standard SCSI-2
  141.         commands. Because of this CompactPlayer keeps track of this
  142.         internally, which will not work 100% if you use the manual controls
  143.         on the CD-ROM drive. This means that CompactPlayer could think that
  144.         the tray is out when it is not, and vice versa. For SCSI-2, there
  145.         seems to be no difference between ejected CD tray and empty CD-ROM
  146.         drive. If someone knows more about this, I'd like to hear about it.
  147.  
  148.     AUTHOR
  149.  
  150.         Osma Ahvenlampi <Osma.Ahvenlampi@hut.fi>
  151.  
  152.         Osma Ahvenlampi
  153.         Rekipellontie 2 F 55
  154.         00940 Helsinki
  155.         Finland
  156.  
  157.     A BLATANT PLUG
  158.  
  159.         Don't forget to check out Voodoo, the definitive Amiga email program.
  160.         A demo version of Voodoo is now available on the World Wide Web at
  161.         http://www.niksula.cs.hut.fi/~oahvenla/voodoo/, and by FTP at
  162.         ftp://ftp.warped.com/pub/amiga/voodoo/.
  163.  
  164.     ANOTHER ADVERTISEMENT
  165.  
  166.         If you're a developer, consider using the ClassAct toolkit for your
  167.         programs! ClassAct makes GUI development a breeze. More information
  168.         is available at http://www.pcnet.com/~caldi or by sending email to
  169.         caldi@pcnet.com.
  170.  
  171.         The source code to CompactPlayer has been included to assist
  172.         evaluating ClassAct. It will not compile without the ClassAct
  173.         developer kit. It is not documented too much, but should be pretty
  174.         easy to read anyhow.
  175.  
  176.     HISTORY
  177.     
  178.         1.7     Number keys select track.
  179.         
  180.                 Utilised the V41 layout.gagdet NoDispose attribute for
  181.                 better main window zoom.
  182.                 
  183.                 Um, what the hell? V40 graphics.library/WritePixelLine8()
  184.                 erases the source array while writing it to the rastport?
  185.                 Nice feature. Double-caching the source to avoid that
  186.                 crap.
  187.     
  188.                 Fixed a bug in the status panel gadget that made it die
  189.                 on native displays. I only tested it on CyberGraphX...
  190.  
  191.         1.6     Added a partial cd.device interface. It's very buggy 
  192.                 though, I wasn't able to abort a play command with it,
  193.                 although I tried to follow the autodoc instructions.
  194.                 Thus, I didn't finish it.
  195.         
  196.                 Localised the interface.
  197.                 
  198.                 Made the main window zoomable.
  199.  
  200.                 Converted the title list editor to use in-place listview
  201.                 edit.
  202.  
  203.                 Added an ARexx port.
  204.  
  205.                 Wasn't setting rastport draw mode in the status panel
  206.                 gadget, so some renders didn't work.
  207.  
  208.                 Editing disc title doesn't reset status panel when disc
  209.                 is playing.
  210.  
  211.                 Reset artist and disc titles for new discs.
  212.  
  213.         1.5     Added a device/unit selection window, iconification, and a
  214.                 simple menu.
  215.  
  216.         1.4     Added SCSI device type checking, fixed another memory free
  217.                 problem.
  218.  
  219.         1.3     Converted to use the ClassAct WindowClass.
  220.  
  221.         1.2     Was freeing some memory twice, how nasty of me.
  222.  
  223.         1.1     Eject uses SCSI direct, because TD_EJECT was dangerous with
  224.                 some controllers.
  225.  
  226.                 Implemented a kludge that retries a play operation until it
  227.                 succeeds. At least the Toshiba XM3601B I have has a tendency
  228.                 to abort PLAY_AUDIO silently just after a media change.
  229.